﻿/*

 * Copyright (c) 2013 Diorge Brognara, Renan Peixoto

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

*/

using System.Collections.Generic;

namespace Grafos {
    /// <summary>
    /// Especialização de List, organiza vértices por Lambda ou pelo Nome
    /// </summary>
    /// <remarks>
    /// A lista não oferece grande consistência quanto à ordenação por métodos convencionais
    /// No entanto, o método ExtrairMenor garante que o vértice com menor Lambda ou Nome é retornado
    /// </remarks>
    /// <see cref="FilaDePrioridadesVértice.ExtrairMenor"/>
    /// <seealso cref="FilaDePrioridadesVértice.Comparador"/>
    public class FilaDePrioridadesVértice : List<Vértice> {

        /// <summary>
        /// Indica se deve usar o comparador de Lambda ou Nome
        /// </summary>
        /// <remarks>
        /// Padrão: Lambda
        /// </remarks>
        public IComparer<Vértice> Comparador { get; set; }

        /// <summary>
        /// Instancia a lista, utilizando comparador Lambda
        /// </summary>
        public FilaDePrioridadesVértice()
            : base() {
            Comparador = new ComparadorLambda();
        }

        /// <summary>
        /// Instancia a lista, com uma capacidade inicial já preparada, utilizando o comparador Lambda
        /// </summary>
        /// <param name="capacidade">Capacidade inicial da lista</param>
        public FilaDePrioridadesVértice(int capacidade)
            : base(capacidade) {
            Comparador = new ComparadorLambda();
        }

        /// <summary>
        /// Instancia a lista, a partir de um conjunto de vértices já existente, utilizando o comparador Lambda
        /// </summary>
        /// <param name="conjunto">Conjunto já existente a ser copiado</param>
        /// <remarks>Após o conjunto ser copiado, ele já é ordenado</remarks>
        public FilaDePrioridadesVértice(IEnumerable<Vértice> conjunto)
            : base(conjunto) {
            Comparador = new ComparadorLambda();
            Sort();
        }

        /// <summary>
        /// Ordenada a fila, de acordo com o Lambda ou Nome dos vértices
        /// </summary>
        public new void Sort() {
            base.Sort(Comparador);
        }

        /// <summary>
        /// Ordena a fila, e então pega o primeiro elemento
        /// </summary>
        /// <returns>O menor dentre os elementos, ou null caso não haja elementos</returns>
        /// <example>
        /// Exemplo utilizando o comparador Lambda:
        /// <code>
        /// FilaDePrioridadesVértice Q = new FilaDePrioridadesVértice();
        /// Vértice[] v = Vértice.CriarConjuntoVértices("V", 3);
        /// Q.AddRange(v);
        /// Q.Comparador = new ComparadorLambda(); // ou new ComparadorNome(), para comparar os nomes
        /// v[0].Lambda = 8;
        /// v[1].Lambda = 3;
        /// v[2].Lambda = 5;
        /// Vértice menor = Q.ExtrairMenor();
        /// // menor = v[1]
        /// // Q = {v[2], v[0]}, nesta ordem
        /// menor = Q.ExtrairMenor();
        /// // menor = v[2]
        /// // Q = {v[0]}
        /// menor = Q.ExtrairMenor();
        /// // menor = v[0]
        /// // Q = {}
        /// menor = Q.ExtrairMenor();
        /// // menor = null
        /// </code>
        /// </example>
        public Vértice ExtrairMenor() {
            Vértice v;
            v = null;
            Sort();
            if (Count > 0) {
                v = this[0];
                RemoveAt(0);
            }
            return v;
        }

    }
}
